/*
 * The MIT License
 *
 * Copyright 2012 http://generic-toolset.googlecode.com.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.rlpw.swing.event;

import java.util.EventObject;

/**
 * An event for identifying an especially item in a data model by the object and the index.
 * @param <T> the type of the item
 */
public class ModelEvent<T> extends EventObject {

    private T item;
    private int index;

    /**
     * Constructs a {@code ModelEvent} object with the specified source, item and index.
     * @param source the {@code Model} that originated the event
     * @param item the item of this {@code ModelEvent}
     * @param index the index of the item
     */
    public ModelEvent(Object source, T item, int index) {
        super(source);
        this.item = item;
        this.index = index;
    }

    /**
     * Returns the index of the item.
     * @return the index of the item
     */
    public int getIndex() {
        return index;
    }

    /**
     * Returns the item of this {@code ModelEvent}.
     * @return the item of this {@code ModelEvent}
     */
    public T getItem() {
        return item;
    }
}
